<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>yLib: yLib::ySharedMemory Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">yLib
   &#160;<span id="projectnumber">V0.0.9 beta</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classyLib_1_1ySharedMemory.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classyLib_1_1ySharedMemory-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">yLib::ySharedMemory Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="ysharedmemory_8hpp_source.html">ysharedmemory.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8449c7068dfe5fadcddad58719a61d92"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyLib_1_1ySharedMemory.html#a8449c7068dfe5fadcddad58719a61d92">ySharedMemory</a> ()</td></tr>
<tr class="separator:a8449c7068dfe5fadcddad58719a61d92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5e5332d05d208d09356dceab295798a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyLib_1_1ySharedMemory.html#ad5e5332d05d208d09356dceab295798a">~ySharedMemory</a> ()</td></tr>
<tr class="separator:ad5e5332d05d208d09356dceab295798a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae93dc46801fcd1cd305f810be5c67c28"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyLib_1_1ySharedMemory.html#ae93dc46801fcd1cd305f810be5c67c28">InitSharedMemory</a> (uint32_t mem_key, uint64_t mem_size, std::_STD_STRING_ mem_name=&quot;DefaultySharedMemory&quot;)</td></tr>
<tr class="separator:ae93dc46801fcd1cd305f810be5c67c28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba904b467a0f405776ce2c0909b0f880"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyLib_1_1ySharedMemory.html#aba904b467a0f405776ce2c0909b0f880">AttacheSharedMemory</a> (void **shm_addr)</td></tr>
<tr class="separator:aba904b467a0f405776ce2c0909b0f880"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07577fc3a1088b61973dcd735d365777"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyLib_1_1ySharedMemory.html#a07577fc3a1088b61973dcd735d365777">DetacheSharedMemory</a> (void *shm_addr)</td></tr>
<tr class="separator:a07577fc3a1088b61973dcd735d365777"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae73ac010be971779b71f5353eee569e6"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyLib_1_1ySharedMemory.html#ae73ac010be971779b71f5353eee569e6">DestroySharedMemory</a> (void)</td></tr>
<tr class="separator:ae73ac010be971779b71f5353eee569e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a2d5c29ef0cc87cf4c464316288a8b5b2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyLib_1_1ySharedMemory.html#a2d5c29ef0cc87cf4c464316288a8b5b2">shm_is_ready</a> = false</td></tr>
<tr class="separator:a2d5c29ef0cc87cf4c464316288a8b5b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9563e839c7e90333c49337068bd281c3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyLib_1_1ySharedMemory.html#a9563e839c7e90333c49337068bd281c3">cur_shm_id</a> = 0</td></tr>
<tr class="separator:a9563e839c7e90333c49337068bd281c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8449c7068dfe5fadcddad58719a61d92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8449c7068dfe5fadcddad58719a61d92">&#9670;&nbsp;</a></span>ySharedMemory()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">yLib::ySharedMemory::ySharedMemory </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ad5e5332d05d208d09356dceab295798a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5e5332d05d208d09356dceab295798a">&#9670;&nbsp;</a></span>~ySharedMemory()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">yLib::ySharedMemory::~ySharedMemory </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aba904b467a0f405776ce2c0909b0f880"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba904b467a0f405776ce2c0909b0f880">&#9670;&nbsp;</a></span>AttacheSharedMemory()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t yLib::ySharedMemory::AttacheSharedMemory </td>
          <td>(</td>
          <td class="paramtype">void **&#160;</td>
          <td class="paramname"><em>shm_addr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ae73ac010be971779b71f5353eee569e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae73ac010be971779b71f5353eee569e6">&#9670;&nbsp;</a></span>DestroySharedMemory()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t yLib::ySharedMemory::DestroySharedMemory </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a07577fc3a1088b61973dcd735d365777"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07577fc3a1088b61973dcd735d365777">&#9670;&nbsp;</a></span>DetacheSharedMemory()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t yLib::ySharedMemory::DetacheSharedMemory </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>shm_addr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ae93dc46801fcd1cd305f810be5c67c28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae93dc46801fcd1cd305f810be5c67c28">&#9670;&nbsp;</a></span>InitSharedMemory()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t yLib::ySharedMemory::InitSharedMemory </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>mem_key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint64_t&#160;</td>
          <td class="paramname"><em>mem_size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::_STD_STRING_&#160;</td>
          <td class="paramname"><em>mem_name</em> = <code>&quot;DefaultySharedMemory&quot;</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9563e839c7e90333c49337068bd281c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9563e839c7e90333c49337068bd281c3">&#9670;&nbsp;</a></span>cur_shm_id</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int yLib::ySharedMemory::cur_shm_id = 0</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a2d5c29ef0cc87cf4c464316288a8b5b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d5c29ef0cc87cf4c464316288a8b5b2">&#9670;&nbsp;</a></span>shm_is_ready</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool yLib::ySharedMemory::shm_is_ready = false</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/sky/yLib/include/ipc/<a class="el" href="ysharedmemory_8hpp_source.html">ysharedmemory.hpp</a></li>
<li>/home/sky/yLib/src/ipc/<a class="el" href="ysharedmemory_8cpp.html">ysharedmemory.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceyLib.html">yLib</a></li><li class="navelem"><a class="el" href="classyLib_1_1ySharedMemory.html">ySharedMemory</a></li>
    <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
  </ul>
</div>
</body>
</html>
